Cisco Packet Tracer Extensions API 8.1.0
API for communication between Cisco Packet Tracer application and its extension applications and modules.
Public Member Functions | List of all members
CloudPotsPort Class Reference

CloudPotsPort is POTS (Modem) port on a Cloud device. More...

Inheritance diagram for CloudPotsPort:
Port Process

Public Member Functions

void setPhoneNumber (string)
 Sets the phone number for this port. More...
 
string getPhoneNumber ()
 Returns the phone number for this port. More...
 
- Public Member Functions inherited from Port
string getName ()
 Returns the name of the port. More...
 
int getChannel ()
 Returns the channel of the port. More...
 
void setChannel (int)
 Sets the channel of the port. More...
 
string getTerminalTypeShortString ()
 Returns the name of the port shortened, without number. More...
 
string getPortNameNumber ()
 Returns the port number. Can have something like 0/0/0, etc. More...
 
PortType getType ()
 Returns the type of the port. More...
 
void setDescription (string)
 Sets the description for the port. More...
 
string getDescription ()
 Returns the description of the port. More...
 
void setPower (bool)
 Sets the power state for the port. More...
 
bool getPower ()
 Returns true if the port is on, false if the port is off. More...
 
void powerChanged (bool)
 This event is emitted when the power state of the port changes. More...
 
bool isStraightPins ()
 Returns true if the pins are straight, for ethernet. More...
 
bool isAutoCross ()
 Returns true if the port is configured for auto crossover, for ethernet. More...
 
void setBandwidth (int)
 Sets the bandwidth for the port. More...
 
int getBandwidth ()
 Returns the bandwidth of the port. More...
 
void setBandwidthAutoNegotiate (bool)
 Enables or disables bandwidth auto negotiation. More...
 
bool isBandwidthAutoNegotiate ()
 Returns true if bandwidth auto negotiation is enabled, otherwise false. More...
 
void setFullDuplex (bool)
 Enables or disables full duplex mode. More...
 
bool isFullDuplex ()
 Returns true if full duplex mode is enabled, otherwise false. More...
 
void setDuplexAutoNegotiate (bool)
 Enables or disables duplex auto negotiation. More...
 
bool isDuplexAutoNegotiate ()
 Returns true if duplex auto negotiation is enabled, otherwise false. More...
 
void setMacAddress (mac)
 Sets the MAC address on the port. More...
 
mac getMacAddress ()
 Returns the MAC address set on the port. More...
 
void macChanged (mac, mac)
 This event is emitted when the MAC address on the port changes. More...
 
mac getBia ()
 Returns the burned-in address of the port. More...
 
void setClockRate (int)
 Sets the clock rate on the port. More...
 
int getClockRate ()
 Returns the clock rate on the port. More...
 
Link getLink ()
 Returns the link connected to the port. More...
 
bool isProtocolUp ()
 Returns true if the line protocol is up on the port, otherwise false. More...
 
bool isPortUp ()
 Returns true if the status is up on the port, otherwise false. More...
 
Process getEncapProcess ()
 Returns the encapsulation process. More...
 
Process getKeepAliveProcess ()
 Returns the keepalive process. More...
 
QString getRemotePortName ()
 Returns the name of the remote port. More...
 
LightStatus getLightStatus ()
 Returns the link light status. More...
 
void lightStatusChanged (LightStatus)
 This event is emitted when the link light changes. More...
 
void lightBlinked ()
 This event is emitted when the link light blinks. More...
 
void portStatusChanged (bool)
 This event is emitted when the port status changes. More...
 
void lineProtocolChanged (bool)
 This event is emitted when the line protocol status changes. More...
 
void packetReceived (string, int)
 This event is emitted when the port receives a packet. More...
 
void packetSent (string, int)
 This event is emitted when the port sends a packet. More...
 
void packetReceivedWithDetails (Signal, int)
 This event is emitted when the port receives a packet with details. More...
 
void packetSentWithDetails (Signal, int)
 This event is emitted when the port sends a packet with details. More...
 
int getHigherProcessCount ()
 Returns the higher process count. More...
 
HardwareQueue getHardwareQueue ()
 Returns the hardware queue. More...
 
QueueProcess getQosQueue ()
 Returns the qos queue. More...
 
bool isEthernetPort ()
 Returns true if it is a ethernet port, false if not. More...
 
bool isWirelessPort ()
 Returns true if it is a wireless port, false if not. More...
 
bool isPowerOn ()
 Returns true if the power is on, false if not. More...
 
void deleteLink ()
 
- Public Member Functions inherited from Process
Device getOwnerDevice ()
 Returns the device for this process. More...
 

Detailed Description

CloudPotsPort is POTS (Modem) port on a Cloud device.

Member Function Documentation

◆ getPhoneNumber()

string CloudPotsPort::getPhoneNumber ( )

Returns the phone number for this port.

Returns
string, the phone number for this port.

◆ setPhoneNumber()

void CloudPotsPort::setPhoneNumber ( string  )

Sets the phone number for this port.

Parameters
phoneNumber,thephone number to set for this port. Phone number format: 5559991234

The documentation for this class was generated from the following file: